Skip to content

feat: add Sphinx as a documentation tool#17

Merged
SaadBazaz merged 3 commits into
UniversalPython:mainfrom
haroon10725:main
Oct 19, 2025
Merged

feat: add Sphinx as a documentation tool#17
SaadBazaz merged 3 commits into
UniversalPython:mainfrom
haroon10725:main

Conversation

@haroon10725

Copy link
Copy Markdown
Collaborator

@SaadBazaz Can you please review it.

@SaadBazaz

Copy link
Copy Markdown
Contributor

Do we really need to include build files (i.e. _build folder and its content)? That may add unnecessary information in this repo.

Instead, we could generate build in the github action and then deploy to GitHub pages directly. No need for an intermediate folder.

Please see if this is possible. If it is, remove the build folder and add it to .gitignore.

@SaadBazaz SaadBazaz left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have some concerns with certain folders and files. Please review and let me know. if it works.

Comment thread .github/workflows/documentation.yaml Outdated
@haroon10725

Copy link
Copy Markdown
Collaborator Author

Do we really need to include build files (i.e. _build folder and its content)? That may add unnecessary information in this repo.

Instead, we could generate build in the github action and then deploy to GitHub pages directly. No need for an intermediate folder.

Please see if this is possible. If it is, remove the build folder and add it to .gitignore.

Yes, we don’t need the _build folder in the repo. It will be automatically generated during the GitHub Actions workflow when building and deploying the documentation.

@haroon10725
haroon10725 requested a review from SaadBazaz October 19, 2025 14:30

@SaadBazaz SaadBazaz left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me. Let's merge and see the results of the GitHub Action.

@SaadBazaz
SaadBazaz merged commit 13ca206 into UniversalPython:main Oct 19, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants